home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / textual / filter / !Filter / !Help < prev    next >
Text File  |  1992-12-30  |  9KB  |  268 lines
  1. !Filter
  2. --------
  3.  
  4. Version 1.00 (30-Dec-92)
  5.  
  6. Files included in this package :-
  7.   
  8.   !Run
  9.   !RunImage
  10.   !Sprites
  11.   !Help     [this file]  
  12.   Templates
  13.   Sprites
  14.   chkspr    ) my chkspr util, rename the app and see what
  15.   !Boot     ) happens (nothing!), description in Comments.
  16.   Deafult   default filter
  17.  
  18.  
  19. This application filters bits and bytes from files! It can
  20. either remove the byte entirely or replace it with another
  21. byte.
  22.  
  23. Eg Remove all CRs if the file has CRLFs
  24.    Change all CRs to LFs
  25.  
  26. It can also strip the top bit from files etc etc etc.
  27.  
  28. It is not a search and replace application, it only 
  29. works on one byte at a time.
  30.  
  31. Filters can be saved and loaded
  32.  
  33. This app was written because my HD was filling up with slow
  34. BASIC file operator programs so I decided to write a nice
  35. WIMP one. The skeleton was my !Cobbler app (take three
  36. 300k sprite files and merge them into one clear file!), all
  37. I needed to do was prune down the ARM code. Easy. Oh no -
  38. the hard part is a nice user interface to permit
  39. modification of filters. Hopefully all that you require is
  40. provided.
  41.  
  42. The WIMP does not multi task during the filtration but
  43. seeing as the filter code is written in ARM code with
  44. memory buffers, it is VERY quick. !Filter will filter a
  45. 100k file in the the time it takes to load and save it
  46. (actually if you choose a filter the removes most of the
  47. characters it will filter in a blink).
  48.  
  49. This app is dedicated to Acorn cos without cribbing the
  50. redraw code from !Chars it would have taken me at least
  51. four times as long.
  52.  
  53. Starting Up
  54. -----------
  55.  
  56. Load !Filter by double clicking on it. Its iconbar sprite
  57. will lodge on the right hand side of the iconbar. If you
  58. click on the iconbar sprite the 'Filter Specification'
  59. window will open. This window allows you to edit the
  60. filter, any edit takes place immediately.
  61.  
  62. You will notice the window is split into two obvious
  63. sections:- an icon section and the filter description. The
  64. ASCII value of any character can be read off the keys above
  65. and to the left of the filter description.
  66.  
  67. There is also a menu accesible from either the iconbar
  68. sprite or 'Filter Specification' window that allows you to
  69. save filter files.
  70.  
  71. Editing the filter
  72. ------------------
  73.  
  74. You can edit the filter in different ways, they are split
  75. in two sections :-
  76.  
  77. 1) You can alter a character so it maps to a different
  78. character
  79.  
  80. 2) You can mask the character out
  81.  
  82. All bottom row icons work only on selected regions.
  83.  
  84. To select a region simply drag SELECT over your chosen area
  85. of the filter. Should you wish to select the whole filter
  86. then just click on 'Select All' ('Clear all' does the
  87. opposite). If you wish to just select one character just
  88. click with SELECT rather than drag. If you did not want to
  89. lose your last selection then use ADJUST instead of SELECT,
  90. it behaves exactly the same without clearing any selected
  91. characters.
  92.  
  93. You can now operate on the selected characters. The
  94. writeable icon on the left allows the entry on a hex byte
  95. (which you could have calculated using my SciCalc!) with
  96. which you could AND, OR or EOR against all of the selected
  97. region. NOT is a unary operator that inverts the
  98. characters. If you click with SELECT you will lose the
  99. selection, ADJUST keeps it.
  100.  
  101. If you select 'Filter out' then rather than seeing the
  102. characters alter you will find a red (or green if they are
  103. selected) spodge. This signifies that these characters will
  104. be removed from any file rather than altered. To reverse
  105. this decision then just select the filtered area and click
  106. on 'Filter out' again.
  107.  
  108. There is one final method of altering the filter and that
  109. is by dragging one character to another while holding
  110. <SHIFT> (actually you need only hold <SHIFT> down when you
  111. begin the drag). Once you complete that drag the character
  112. you started on will replace the character you finished on.
  113. If you decided that the drag was not such a good idea then
  114. just finish the drag somewhere off the filter desciption
  115. (ie the icon area).
  116.  
  117. You can now save the filter you have created by calling
  118. the menu up (over the 'Filter Specificaton' window or
  119. iconbar sprite - they are exactly the same) and using the
  120. standard save box in the 'Save' submenu.
  121.  
  122. You can load filter files by double clicking on them or
  123. dropping them on any part of the !Filter application, this
  124. overwrites the old file.
  125.  
  126. 'Reset' clears the filter so that should any file be
  127. dropped on !Filter it will be completely unaltered.
  128.  
  129.  
  130. Using the filter
  131. ----------------
  132.  
  133. Using the filter is dead easy. Simply drop any file you
  134. wish to be filtered on the iconbar sprite (or 'Filter
  135. Specification' window if you wish) and then drag the
  136. resulting save box onto an awaiting directory viewer (or
  137. any application you wish - !Filter supports inter-
  138. application file transfer, although only with Wimp$Scrap).
  139. Hopefully the saved file will be filtered. All files will
  140. maintain the filetype they orignially possesed and the only
  141. type that will be intercepted is that of filter files with,
  142. of course, will be loaded as filters!
  143.  
  144. If you click on !Filter's iconbar sprite or the 'Filter
  145. Specification' window the save box will disappear and you
  146. will have to repeat the drag. Do note that !Filter suggests
  147. a filename that is the same as the one dragged onto it but
  148. with an appended '/', if the leafname is ten characters
  149. long then the leafname will be truncated to nine characters
  150. to permit the addition of the '/' character.
  151.  
  152.  
  153. Configuration
  154. -------------
  155.  
  156. If there if a filter file in the application directory
  157. named 'Default' then this will be loaded at the time the
  158. application is run so long as you have not double-clicked
  159. on another filter file.
  160.  
  161. Filter files have file type &043
  162.  
  163. If you wish to change the type of the filter files then you
  164. need to alter the system variable in the file '!Boot' that
  165. reads :-
  166.  
  167. Set Filter$FileType 043
  168.  
  169. to the value you wish the type to be. Do note that if the
  170. value is not a three digit hex number then it will be
  171. rejected and !Filter will use &043 instead. Double click on
  172. the '!Boot' file once you have changed the filetype to
  173. update some of !Filter's system variables.
  174.  
  175.  
  176. Filter File Format
  177. ------------------
  178.  
  179. Filter files are 512 bytes long. They are split into two
  180. parts of 256 bytes. Bytes 0 to 255 contain the
  181. corresponding bytes that replace ASCII values 0 to 255.
  182. Bytes 256 to 511 contain boolean flags (one per byte).
  183. These correspond to ASCII values 0 to 255 and if the flag
  184. is true then !Filter will completely filter out that ASCII
  185. value.
  186.  
  187.  
  188. Comments
  189. --------
  190.  
  191.   The ChkSpr Utility
  192.  
  193.   The chkspr utility will, when run, examine the '!Sprites'
  194. file and check if the first sprite is the application's
  195. name. If not that sprite's name will be changed to the
  196. application directory's name. The !Boot file contains
  197. 'Run ChkSpr', this runs the util, the next line contains
  198. 'IconSprites <Obey$Dir>.!Sprites' this loads the new sprite
  199. in. The filer always calls any new (ie renamed) app's !Boot
  200. file so the new sprite is automatically loaded for display.
  201.  
  202. Please feel free to use the utility separately from the
  203. rest of the package but please note that the conditions set
  204. out below apply to it.
  205.  
  206. Versions
  207. --------
  208.  
  209. v1.00   Initial release 
  210.  
  211.  
  212. Conditions of Use
  213. -----------------
  214.  
  215.   This application is supplied free to everyone 'as is', I
  216. do not give any guarantee that it is free of bugs, or
  217. supply any warranty about its suitabliliy for use. However
  218. if there are any problems with it and you notify me of them
  219. then I probably will do my best to recify them.
  220.  
  221.   You are may give this application to anyone, via any
  222. medium, so long as :- 
  223.  
  224.   1) It is delivered with ALL the supplied files and
  225.      unaltered (except !Run & !Boot files) .
  226.  
  227.   2) It is not supplied on a disc you are charging
  228.      for (except for media and postage costs).
  229.   
  230.   You have permission to use any part or the whole
  231. application in a project you intend to place in the public
  232. domain, as long as I am fully credited. If you wish to use
  233. these routines in a program that is for sale (for however
  234. much and for whatever reasons) or released as copyright
  235. material then my express permission in writing must be
  236. obtained. I maintain copyright on all the material
  237. supplied and reserve the right to amend these conditions in
  238. cases where I deem misuse.
  239.  
  240.    A large number of hours of work have gone into the
  241. production and maintenance of this application and although
  242. I have supplied the application free, donations will be
  243. gratefully received (and if over 10 pounds I will send you
  244. a disc with updates of this and all other pd stuff I have
  245. written. Please include a letter telling me which apps of
  246. mine you use and their version numbers).
  247.  
  248.  
  249. Contacts
  250. --------
  251.  
  252. My address:
  253.  
  254.   6 Parklands Place,
  255.   Guildford,
  256.   Surrey GU1 2PS.
  257.  
  258. BBSs I call frequently:
  259.  
  260.  
  261.   Arcade  BBS          [081 654 2212]   mbx 23
  262.  
  263. email
  264.  
  265.   maurp@uk.ac.warwick.cu
  266.  
  267. © Emmet Spier 1992 - USE and Enjoy!
  268.